<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="admin_directory_v1.html">Admin SDK API</a> . <a href="admin_directory_v1.members.html">members</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#delete">delete(groupKey, memberKey, x__xgafv=None)</a></code></p>
<p class="firstline">Removes a member from a group.</p>
<p class="toc_element">
  <code><a href="#get">get(groupKey, memberKey, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a group member's properties.</p>
<p class="toc_element">
  <code><a href="#hasMember">hasMember(groupKey, memberKey, x__xgafv=None)</a></code></p>
<p class="firstline">Checks whether the given user is a member of the group. Membership can be direct or nested, but if nested, the `memberKey` and `groupKey` must be entities in the same domain or an `Invalid input` error is returned. To check for nested memberships that include entities outside of the group's domain, use the [`checkTransitiveMembership()`](https://cloud.google.com/identity/docs/reference/rest/v1/groups.memberships/checkTransitiveMembership) method in the Cloud Identity Groups API.</p>
<p class="toc_element">
  <code><a href="#insert">insert(groupKey, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a user to the specified group.</p>
<p class="toc_element">
  <code><a href="#list">list(groupKey, includeDerivedMembership=None, maxResults=None, pageToken=None, roles=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(groupKey, memberKey, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the membership properties of a user in the specified group. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).</p>
<p class="toc_element">
  <code><a href="#update">update(groupKey, memberKey, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the membership of a user in the specified group.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(groupKey, memberKey, x__xgafv=None)</code>
  <pre>Removes a member from a group.

Args:
  groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
  memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member&#x27;s (group or user) primary email address, alias, or unique ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
</pre>
</div>

<div class="method">
    <code class="details" id="get">get(groupKey, memberKey, x__xgafv=None)</code>
  <pre>Retrieves a group member&#x27;s properties.

Args:
  groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
  memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member&#x27;s (group or user) primary email address, alias, or unique ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
  &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
  &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
  &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
  &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
  &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
  &quot;type&quot;: &quot;A String&quot;, # The type of group member.
}</pre>
</div>

<div class="method">
    <code class="details" id="hasMember">hasMember(groupKey, memberKey, x__xgafv=None)</code>
  <pre>Checks whether the given user is a member of the group. Membership can be direct or nested, but if nested, the `memberKey` and `groupKey` must be entities in the same domain or an `Invalid input` error is returned. To check for nested memberships that include entities outside of the group&#x27;s domain, use the [`checkTransitiveMembership()`](https://cloud.google.com/identity/docs/reference/rest/v1/groups.memberships/checkTransitiveMembership) method in the Cloud Identity Groups API.

Args:
  groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
  memberKey: string, Identifies the user member in the API request. The value can be the user&#x27;s primary email address, alias, or unique ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # JSON template for Has Member response in Directory API.
  &quot;isMember&quot;: True or False, # Output only. Identifies whether the given user is a member of the group. Membership can be direct or nested.
}</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(groupKey, body=None, x__xgafv=None)</code>
  <pre>Adds a user to the specified group.

Args:
  groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
  &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
  &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
  &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
  &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
  &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
  &quot;type&quot;: &quot;A String&quot;, # The type of group member.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
  &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
  &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
  &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
  &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
  &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
  &quot;type&quot;: &quot;A String&quot;, # The type of group member.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(groupKey, includeDerivedMembership=None, maxResults=None, pageToken=None, roles=None, x__xgafv=None)</code>
  <pre>Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see [Troubleshoot error codes](https://developers.google.com/workspace/admin/directory/v1/guides/troubleshoot-error-codes).

Args:
  groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
  includeDerivedMembership: boolean, Whether to list indirect memberships. Default: false.
  maxResults: integer, Maximum number of results to return. Max allowed value is 200.
  pageToken: string, Token to specify next page in the list.
  roles: string, The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`, `MANAGER`, and `MEMBER`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;kind&quot;: &quot;admin#directory#members&quot;, # Kind of resource this is.
  &quot;members&quot;: [ # A list of member objects.
    { # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
      &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
      &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
      &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
      &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
      &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
      &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
      &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
      &quot;type&quot;: &quot;A String&quot;, # The type of group member.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token used to access next page of this result.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(groupKey, memberKey, body=None, x__xgafv=None)</code>
  <pre>Updates the membership properties of a user in the specified group. This method supports [patch semantics](https://developers.google.com/workspace/admin/directory/v1/guides/performance#patch).

Args:
  groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
  memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member&#x27;s (group or user) primary email address, alias, or unique ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
  &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
  &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
  &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
  &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
  &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
  &quot;type&quot;: &quot;A String&quot;, # The type of group member.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
  &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
  &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
  &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
  &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
  &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
  &quot;type&quot;: &quot;A String&quot;, # The type of group member.
}</pre>
</div>

<div class="method">
    <code class="details" id="update">update(groupKey, memberKey, body=None, x__xgafv=None)</code>
  <pre>Updates the membership of a user in the specified group.

Args:
  groupKey: string, Identifies the group in the API request. The value can be the group&#x27;s email address, group alias, or the unique group ID. (required)
  memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member&#x27;s (group or user) primary email address, alias, or unique ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
  &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
  &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
  &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
  &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
  &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
  &quot;type&quot;: &quot;A String&quot;, # The type of group member.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Google Groups member can be a user or another group. This member can be inside or outside of your account&#x27;s domains. For more information about common group member tasks, see the [Developer&#x27;s Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-group-members).
  &quot;delivery_settings&quot;: &quot;A String&quot;, # Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
  &quot;email&quot;: &quot;A String&quot;, # The member&#x27;s email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
  &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
  &quot;id&quot;: &quot;A String&quot;, # The unique ID of the group member. A member `id` can be used as a member request URI&#x27;s `memberKey`.
  &quot;kind&quot;: &quot;admin#directory#member&quot;, # The type of the API resource. For Members resources, the value is `admin#directory#member`.
  &quot;role&quot;: &quot;A String&quot;, # The member&#x27;s role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member&#x27;s role, see the [administration help center](https://support.google.com/a/answer/167094).
  &quot;status&quot;: &quot;A String&quot;, # Status of member (Immutable)
  &quot;type&quot;: &quot;A String&quot;, # The type of group member.
}</pre>
</div>

</body></html>